docs: promote AGENTS.md to canonical and import it from CLAUDE.md#66
Merged
Conversation
Un-ignore AGENTS.md (was in .gitignore) and reduce CLAUDE.md to the bare `@AGENTS.md` import so the canonical guide is tracked and the two files can't drift. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Promote AGENTS.md to the single source of truth, re-verified against code: 16 toggl_ tools, TOGGL_API_KEY||TOGGL_API_TOKEN||TOGGL_TOKEN auth aliases, TOGGL_DEFAULT_WORKSPACE_ID (not TOGGL_WORKSPACE_ID), Vitest, 7-file src/, Basic auth (token:api_token). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Promotes AGENTS.md to the canonical, tracked agent-guidance document and reduces CLAUDE.md to an import stub so multiple agent tools can share a single source of truth without drift.
Changes:
- Replace the existing multi-section
CLAUDE.mdwith a single@AGENTS.mdimport. - Add a comprehensive, code-referenced
AGENTS.mdas the canonical guidance document. - Stop ignoring
AGENTS.mdso it is tracked in git.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
CLAUDE.md |
Replaced with a one-line import of AGENTS.md to avoid duplicated guidance. |
AGENTS.md |
Added canonical agent instructions (commands, architecture, tools, env vars, CI) aligned to current repo state. |
.gitignore |
Removed AGENTS.md from ignore rules so it can be committed/tracked. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
ensureCache (src/index.ts:159) sets cacheWarmed=true even when it cannot resolve a workspace, so it only pre-warms project/client/tag data when a workspace is resolvable (TOGGL_DEFAULT_WORKSPACE_ID or a single workspace). With multiple workspaces and no default, entities are fetched lazily instead. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What & why
Adopts the house standard for agent-direction files and freshens the content against the current code.
The standard:
AGENTS.mdis the single source of truth;CLAUDE.mdis one line —@AGENTS.md— that imports it. Only Claude Code resolves the import; every other agent (Cursor, Codex, etc.) readsAGENTS.md's literal bytes. Token-neutral, and it kills drift between the two files.Honest framing: this is not fixing a live two-file divergence. An
AGENTS.mdexisted in the working tree but was gitignored and untracked — so it never shipped, and the only doc the repo actually carried was a 65-lineCLAUDE.md. This PR un-ignoresAGENTS.md, promotes it to canonical (freshened against code), and pointsCLAUDE.mdat it via the import. Net effect: every agent — not just Claude Code — now gets an accurate, tracked project guide.Commits, reviewed separately
docs: track AGENTS.md and make CLAUDE.md import it— mechanical: dropAGENTS.mdfrom.gitignore, track it, and replaceCLAUDE.mdwith the bare@AGENTS.mdimport.docs: add canonical AGENTS.md freshened against code— the freshness rewrite (every factual claim grounded in code, withpath:linecitations).What was re-verified against code
toggl_tools, all prefixedtoggl_(tools array insrc/index.ts;server.jsonlists the same 16). Reflects v1.1.0.TOGGL_API_KEY || TOGGL_API_TOKEN || TOGGL_TOKEN(src/index.ts:127), value.trim()-ed, exits if none set (src/index.ts:131-135); legacy aliases log a deprecation warning.TOGGL_WORKSPACE_IDvar — the default-workspace var isTOGGL_DEFAULT_WORKSPACE_ID(src/index.ts:148). Optional cache vars:TOGGL_CACHE_TTL=3600000,TOGGL_CACHE_SIZE=1000,TOGGL_BATCH_SIZE=100(src/index.ts:143-145).api_tokenas password (src/toggl-api.ts:63) — not a bearer token.vitest run), not Jest; HTTP is mocked so the suite needs no Toggl credentials.src/includingtimeline.tsandworkspace.ts(both omitted from the oldCLAUDE.md).Verification limits
The automated checks (tool names/count exist, env vars exist, referenced paths/scripts exist,
CLAUDE.mdis exactly@AGENTS.md, both files tracked,AGENTS.mdun-ignored) catch mechanical drift only — not judgment staleness. Please read the diff for whether the advice and emphasis are still right.🤖 Generated with Claude Code